github: rewrite PR guide for clarity and detail#294
Merged
Conversation
- Added exclusion of `**.props` files in `CleanupCode` task to prevent unintended processing. - Removed unnecessary whitespaces from `Directory.Packages.props` file for consistent formatting.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #294 +/- ##
==========================================
+ Coverage 87.32% 87.35% +0.03%
==========================================
Files 131 131
Lines 2919 2919
Branches 351 351
==========================================
+ Hits 2549 2550 +1
+ Misses 269 268 -1
Partials 101 101 see 1 file with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
- Expanded the PR creation guide with stricter conventional commit validation rules. - Added detailed PR workflows, including pre-flight checks, title validation, and auto-suggestions. - Provided updated templates for PR body and title examples for user guidance. - Included troubleshooting tips and edge-case guidance for handling scopes and titles.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



🚀 Pull Request
📋 Summary
This PR includes two sets of improvements:
Documentation Enhancement: Complete rewrite of
.claude/commands/pr.mdwith:XML Formatting Improvements:
Directory.Packages.propsfor consistency (changed XML attributes to use self-closing tags without spaces)tasks/FormattingTasks.ymlto exclude**.propsfiles from CleanupCode to preserve manual formatting✅ Checklist
🧪 Related Issues or PRs
N/A
💬 Notes for Reviewers
The documentation changes significantly expand the PR guide with validation rules and examples to help ensure PR titles follow conventional commit format. The formatting changes are minor but important for maintaining consistent XML formatting in package management files.